The FHIR profile used for Organization

Heading Description

A generic organization profile created using the CareConnect Level 2 CareConnect-Organization-1 profile, using the elements required to support its use within the Digital Maternity Messaging Specification.

Mapping for Organization

> Level 1 Organization Resource > Level 2 CareConnect-Organization-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
Organization     A grouping of people or organizations with a common purpose
Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources
Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative
Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Constraint (org-1): The organization SHALL at least have a name or an id, and possibly more than one
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1'
- implicitRules 0..1 Not Used Uri A set of rules under which this content was created
- language 0..1 Not Used Code Language of the resource content
Binding (extensible): A human language. Common Languages
- text 0..1 Not Used Narrative Text summary of the resource, for human interpretation
- contained 0..* Not Used Resource Contained, inline Resources
- extension (mainLocation) 0..1 Optional Extension-CareConnect-MainLocation-1 Main location
Constraint (ext-1): Must have either extensions or value[x], not both
- extension (organization-period) 0..1 Optional organization-period The date range that this organization should be considered available
Constraint (ext-1): Must have either extensions or value[x], not both
- modifierExtension 0..* Not Used Extension Extensions that cannot be ignored
Constraint (ext-1): Must have either extensions or value[x], not both
Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open
- identifier 0..* Required Identifier Identifies this organization across multiple systems
Slicing: Discriminator: system, Ordering: false, Rules: Open at End
- identifier (odsOrganisationCode) 0..1 Optional Identifier Organisation Data Service code
- - use 0..1 Optional Code usual : official : temp : secondary (If known)
Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse
- - type 0..1 Optional CodeableConcept Description of identifier
Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes
- - system 1..1 Mandatory Uri The namespace for the identifier value
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/Id/ods-organization-code'
- - value 1..1 Mandatory String The value that is unique
- - period 0..1 Not Used Period Time period when id is/was valid for use
Constraint (per-1): If present, start SHALL have a lower value than end
- - assigner 0..1 Optional Reference Organization that issued id (may be just text)
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
- identifier (odsSiteCode) 0..1 Optional Identifier ODS Site code to identify the organisation at site level
- - use 0..1 Optional Code usual : official : temp : secondary (If known)
Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse
- - type 0..1 Optional CodeableConcept Description of identifier
Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes
- - system 1..1 Mandatory Uri The namespace for the identifier value
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/Id/ods-site-code'
- - value 1..1 Mandatory String The value that is unique
- - period 0..1 Not Used Period Time period when id is/was valid for use
Constraint (per-1): If present, start SHALL have a lower value than end
- - assigner 0..1 Optional Reference Organization that issued id (may be just text)
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
- active 0..1 Optional Boolean Whether the organization’s record is still in active use
Default Value: true
- type 0..* Optional CodeableConcept Kind of organization
Binding (example): Used to categorize the organization OrganizationType
- - coding 0..* Optional Coding Code defined by a terminology system
- - - system 0..1 Optional Uri Identity of the terminology system
- - - version 0..1 Not Used String Version of the system - if relevant
- - - code 0..1 Optional Code Symbol in syntax defined by the system
- - - display 0..1 Optional String Representation defined by the system
- - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - text 0..1 Optional String Plain text representation of the concept
- name 0..1 Optional String Name used for the organization
- alias 0..* Optional String A list of alternate names that the organization is known as, or was known as in the past
- telecom 0..* Optional ContactPoint A contact detail for the organization
Constraint (cpt-2): A system is required if a value is provided.
Constraint (org-3): The telecom of an organization can never be of use ‘home’
- - system 0..1 Optional Code phone : fax : email : pager : url : sms : other
Binding (required): Telecommunications form for contact point ContactPointSystem
- - value 0..1 Optional String The actual contact point details
- - use 0..1 Optional Code home : work : temp : old : mobile - purpose of this contact point
Binding (required): Use of contact point ContactPointUse
- - rank 0..1 Optional positiveInt Specify preferred order of use (1 = highest)
- - period 0..1 Not Used Period Time period when the contact point was/is in use
Constraint (per-1): If present, start SHALL have a lower value than end
- - - start 0..1 Not Used dateTime Starting time with inclusive boundary
- - - end 0..1 Not Used dateTime End time with inclusive boundary, if not ongoing
- address 0..* Optional Address An address for the organization
Constraint (org-2): An address of an organization can never be of use ‘home’
- - use 0..1 Optional Code home : work : temp : old - purpose of this address
Binding (required): The use of an address AddressUse
- - type 0..1 Optional Code postal : physical : both
Binding (required): The type of an address (physical / postal) AddressType
- - text 0..1 Optional String Text representation of the address
- - line 0..* Optional String Street name, number, direction & P.O. Box etc.
- - city 0..1 Optional String Name of city, town etc.
- - district 0..1 Optional String District name (aka county)
- - state 0..1 Optional String Sub-unit of country (abbreviations ok)
- - postalCode 0..1 Optional String Postal code for area
- - country 0..1 Optional String Country (e.g. can be ISO 3166 2 or 3 letter code)
- - period 0..1 Not Used Period Time period when address was/is in use
Constraint (per-1): If present, start SHALL have a lower value than end
- - - start 0..1 Not Used dateTime Starting time with inclusive boundary
- - - end 0..1 Not Used dateTime End time with inclusive boundary, if not ongoing
- partOf 0..1 Optional Reference The organization of which this organization forms a part
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
- - reference 0..1 Optional String Literal reference, Relative, internal or absolute URL
- - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - display 0..1 Optional String Text alternative for the resource
- contact 0..* Not Used BackboneElement Contact for the organization for a certain purpose
- - modifierExtension 0..* Not Used Extension Extensions that cannot be ignored
Constraint (ext-1): Must have either extensions or value[x], not both
- - purpose 0..1 Not Used CodeableConcept The type of contact
Binding (extensible): The purpose for which you would contact a contact party ContactEntityType
- - - coding 0..* Not Used Coding Code defined by a terminology system
- - - - system 0..1 Not Used Uri Identity of the terminology system
- - - - version 0..1 Not Used String Version of the system - if relevant
- - - - code 0..1 Not Used Code Symbol in syntax defined by the system
- - - - display 0..1 Not Used String Representation defined by the system
- - - - userSelected 0..1 Not Used Boolean If this coding was chosen directly by the user
- - - text 0..1 Not Used String Plain text representation of the concept
- - name 0..1 Not Used HumanName A name associated with the contact
- - - use 0..1 Not Used Code usual : official : temp : nickname : anonymous : old : maiden
Binding (required): The use of a human name NameUse
- - - text 0..1 Not Used String Text representation of the full name
- - - family 1..1 Not Used String Family name (often called ‘Surname’)
- - - given 0..* Not Used String Given names (not always ‘first’). Includes middle names
- - - prefix 0..* Not Used String Parts that come before the name
- - - suffix 0..* Not Used String Parts that come after the name
- - - period 0..1 Not Used Period Time period when name was/is in use
Constraint (per-1): If present, start SHALL have a lower value than end
- - - - start 0..1 Not Used dateTime Starting time with inclusive boundary
- - - - end 0..1 Not Used dateTime End time with inclusive boundary, if not ongoing
- - telecom 0..* Not Used ContactPoint Contact details (telephone, email, etc.) for a contact
Constraint (cpt-2): A system is required if a value is provided.
- - - system 0..1 Not Used Code phone : fax : email : pager : url : sms : other
Binding (required): Telecommunications form for contact point ContactPointSystem
- - - value 0..1 Not Used String The actual contact point details
- - - use 0..1 Not Used Code home : work : temp : old : mobile - purpose of this contact point
Binding (required): Use of contact point ContactPointUse
- - - rank 0..1 Not Used positiveInt Specify preferred order of use (1 = highest)
- - - period 0..1 Not Used Period Time period when the contact point was/is in use
Constraint (per-1): If present, start SHALL have a lower value than end
- - - - start 0..1 Not Used dateTime Starting time with inclusive boundary
- - - - end 0..1 Not Used dateTime End time with inclusive boundary, if not ongoing
- - address 0..1 Not Used Address Visiting or postal addresses for the contact
- - - use 0..1 Not Used Code home : work : temp : old - purpose of this address
Binding (required): The use of an address AddressUse
- - - type 0..1 Not Used Code postal : physical : both
Binding (required): The type of an address (physical / postal) AddressType
- - - text 0..1 Not Used String Text representation of the address
- - - line 0..* Not Used String Street name, number, direction & P.O. Box etc.
- - - city 0..1 Not Used String Name of city, town etc.
- - - district 0..1 Not Used String District name (aka county)
- - - state 0..1 Not Used String Sub-unit of country (abbreviations ok)
- - - postalCode 0..1 Not Used String Postal code for area
- - - country 0..1 Not Used String Country (e.g. can be ISO 3166 2 or 3 letter code)
- - - period 0..1 Not Used Period Time period when address was/is in use
Constraint (per-1): If present, start SHALL have a lower value than end
- - - - start 0..1 Not Used dateTime Starting time with inclusive boundary
- - - - end 0..1 Not Used dateTime End time with inclusive boundary, if not ongoing
- endpoint 0..* Not Used Reference Technical endpoints providing access to services operated for the organization
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Not Used Endpoint  
- - reference 0..1 Not Used String Literal reference, Relative, internal or absolute URL
- - identifier 0..1 Not Used Identifier Logical reference, when literal reference is not known
Tags: fhir