Universal API Implementation Guide
1.1.20 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: UAPI Organization

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-organization Version: 1.1.20
Active as of 2021-06-04 Computable Name: UapiOrganization

This profile constrains the Organization resource for representing practice and insurance

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Unique identifier for the organization
Example General: 123456
... type SΣ 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name SΣC 1..1 string Max 255 Characters
... Slices for telecom SC 1..* ContactPoint A contact detail for the organization
Slice: Unordered, Closed by value:system
Constraints: org-3
.... telecom:All Slices Content/Rules for all slices
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ 0..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Phone SC 1..* ContactPoint A contact detail for the organization
Constraints: org-3
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ 0..1 string Phone (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Fax SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value SΣ 0..1 string Fax (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC 0..* Address Address is required for Practice Organization and Site of Treatment
Constraints: org-2
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... line Σ 1..3 string Max 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Max 30 Characters
Example General: Erewhon
.... state Σ 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ 1..1 string Max 10 Characters
Example General: 9132
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 HumanName A name associated with the contact
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... family SΣ 1..1 string Max 40 Characters
..... given SΣ 1..1 string Max 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ 0..1 string The actual contact point details
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value SΣ 0..1 string Phone (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value SΣ 0..1 string Fax (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value SΣ 0..1 string Email format
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.3.0
From the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:Phone, Organization.telecom:FaxThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization Organization
... identifier S 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string Unique identifier for the organization
... type S 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name S 1..1 string Max 255 Characters
.... telecom:All Slices Content/Rules for all slices
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... telecom:Phone S 1..* ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value 0..1 string Phone (10 digit numeric values only)
.... telecom:Fax S 0..* ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: fax
..... value 0..1 string Fax (10 digit numeric values only)
... address S 0..* Address Address is required for Practice Organization and Site of Treatment
.... line 1..3 string Max 255 Characters
.... city 1..1 string Max 30 Characters
.... state 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode 1..1 string Max 10 Characters
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... name
..... family S 1..1 string Max 40 Characters
..... given S 1..1 string Max 80 Characters
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system S 0..1 code phone | fax | email | pager | url | sms | other
...... value S 0..1 string The actual contact point details
...... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
...... value 0..1 string Phone (10 digit numeric values only)
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: fax
...... value 0..1 string Fax (10 digit numeric values only)
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
...... value 0..1 string Email format

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... id 0..1 id 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Unique identifier for the organization
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 SΣ 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name SΣC 1..1 string Max 255 Characters
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 1..* ContactPoint A contact detail for the organization
Slice: Unordered, Closed by value:system
Constraints: org-3
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ 0..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:Phone SC 1..* ContactPoint A contact detail for the organization
Constraints: org-3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ 0..1 string Phone (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:Fax SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value SΣ 0..1 string Fax (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address Address is required for Practice Organization and Site of Treatment
Constraints: org-2
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..3 string Max 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Max 30 Characters
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ 1..1 string Max 10 Characters
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... 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
..... id 0..1 id 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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Max 40 Characters
..... given SΣ 1..1 string Max 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ 0..1 string The actual contact point details
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value SΣ 0..1 string Phone (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value SΣ 0..1 string Fax (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value SΣ 0..1 string Email format
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.3.0
From the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningOrganization.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:Phone, Organization.telecom:FaxThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 20 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.telecom (Closed)
  • The element 1 is sliced based on the value of Organization.contact.telecom (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Unique identifier for the organization
Example General: 123456
... type SΣ 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name SΣC 1..1 string Max 255 Characters
... Slices for telecom SC 1..* ContactPoint A contact detail for the organization
Slice: Unordered, Closed by value:system
Constraints: org-3
.... telecom:All Slices Content/Rules for all slices
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ 0..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Phone SC 1..* ContactPoint A contact detail for the organization
Constraints: org-3
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ 0..1 string Phone (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Fax SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value SΣ 0..1 string Fax (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC 0..* Address Address is required for Practice Organization and Site of Treatment
Constraints: org-2
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... line Σ 1..3 string Max 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Max 30 Characters
Example General: Erewhon
.... state Σ 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ 1..1 string Max 10 Characters
Example General: 9132
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 HumanName A name associated with the contact
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... family SΣ 1..1 string Max 40 Characters
..... given SΣ 1..1 string Max 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ 0..1 string The actual contact point details
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value SΣ 0..1 string Phone (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value SΣ 0..1 string Fax (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value SΣ 0..1 string Email format
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.3.0
From the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:Phone, Organization.telecom:FaxThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization Organization
... identifier S 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string Unique identifier for the organization
... type S 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name S 1..1 string Max 255 Characters
.... telecom:All Slices Content/Rules for all slices
..... system S 0..1 code phone | fax | email | pager | url | sms | other
..... value S 0..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... telecom:Phone S 1..* ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value 0..1 string Phone (10 digit numeric values only)
.... telecom:Fax S 0..* ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: fax
..... value 0..1 string Fax (10 digit numeric values only)
... address S 0..* Address Address is required for Practice Organization and Site of Treatment
.... line 1..3 string Max 255 Characters
.... city 1..1 string Max 30 Characters
.... state 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode 1..1 string Max 10 Characters
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... name
..... family S 1..1 string Max 40 Characters
..... given S 1..1 string Max 80 Characters
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system S 0..1 code phone | fax | email | pager | url | sms | other
...... value S 0..1 string The actual contact point details
...... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
...... value 0..1 string Phone (10 digit numeric values only)
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: fax
...... value 0..1 string Fax (10 digit numeric values only)
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
...... value 0..1 string Email format

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifier used by Genentech to determine insert vs update operation.
.... id 0..1 id 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Unique identifier for the organization
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 SΣ 1..1 CodeableConcept Organization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes
... name SΣC 1..1 string Max 255 Characters
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 1..* ContactPoint A contact detail for the organization
Slice: Unordered, Closed by value:system
Constraints: org-3
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ 0..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:Phone SC 1..* ContactPoint A contact detail for the organization
Constraints: org-3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ 0..1 string Phone (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:Fax SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value SΣ 0..1 string Fax (10 digit numeric values only)
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address Address is required for Practice Organization and Site of Treatment
Constraints: org-2
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..3 string Max 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Max 30 Characters
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 1..1 string Standard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ 1..1 string Max 10 Characters
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact is required for Practice Organization
.... 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
..... id 0..1 id 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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Max 40 Characters
..... given SΣ 1..1 string Max 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... Slices for telecom S 1..* ContactPoint Required for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ 0..1 string The actual contact point details
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value SΣ 0..1 string Phone (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Fax S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value SΣ 0..1 string Fax (10 digit numeric values only)
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:Email S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value SΣ 0..1 string Email format
...... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.typerequiredUapiValueSetOrganizationType
https://fhir.developer.gene.com/ValueSet/uapi-org-type
From this IG
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.3.0
From the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
From the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningOrganization.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:Phone, Organization.telecom:FaxThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 20 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.telecom (Closed)
  • The element 1 is sliced based on the value of Organization.contact.telecom (Closed)

 

Other representations of profile: CSV, Excel, Schematron