Digital Child Health Service - Events Catalogue

CareConnect-DCH-Organization-1

The Organization resource represents a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

NameCard.TypeDescription & Constraints
..OrganizationOrganizationA grouping of people or organizations with a common purpose

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...mainLocation0..1ExtensionMain location
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-MainLocation-1

...organization-period0..1ExtensionThe date range that this organization should be considered available
Extension http://hl7.org/fhir/StructureDefinition/organization-period

...identifier0..*Identifies this organization across multiple systems
Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End

...identifier (ODS Organisation Code)0..1IdentifierOrganisation Data Service code

....id0..1Idxml:id (or equivalent in JSON)

....system1..1UriThe namespace for the identifier
Fixed Value https://fhir.nhs.uk/Id/ods-organization-code

....value1..1StringThe value that is unique
Example Value 123456

...identifier (ODS Site Code)0..1IdentifierODS Site code to identify the organisation at site level

....id0..1Idxml:id (or equivalent in JSON)

....system1..1UriThe namespace for the identifier
Fixed Value https://fhir.nhs.uk/Id/ods-site-code

....value1..1StringThe value that is unique
Example Value 123456

...identifier (localIdentifier)0..*IdentifierIdentifies this organization across multiple systems

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe local or system suppliers identifier namespace
Fixed Value https://fhir.nhs.uk/Id/local-organization-code

....value1..1StringThe value that is unique
Example Value 123456

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (CareConnect-DCH-Organization-1)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...active0..1BooleanWhether the organization's record is still in active use.
Default Value true

...type0..1CodeableConceptKind of organization
Binding Used to categorize the organization (http://hl7.org/fhir/ValueSet/organization-type)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..*CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system
Example Value http://hl7.org/fhir/organization-type

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

....text0..1StringPlain text representation of the concept

...name1..1StringName used for the organization

...telecom0..*ContactPointA contact detail for the organization

....id0..1Idxml:id (or equivalent in JSON)

....system0..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required

....value0..1StringThe actual contact point details

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required

....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

....period0..1PeriodTime period when the contact point was/is in use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...address0..*AddressAn address for the organization

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value work

....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

....text0..1StringText representation of the address
Example Value 1, Main Street, Leeds, West Yorkshire, LS1 3PO

....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 1, Main Street

....city0..1StringName of city, town etc.
Example Value Leeds

....district0..1StringDistrict name (aka county)
Example Value West Yorkshire

....postalCode0..1StringPostal code for area
Example Value LS1 3PO

....country0..1StringCountry (can be ISO 3166 3 letter code)
Example Value GBR

....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...partOf0..1Reference (CareConnect-DCH-Organization-1)The organization of which this organization forms a part

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...contact0..*BackboneElementContact for the organization for a certain purpose

....id0..1Idxml:id (or equivalent in JSON)

....purpose0..1CodeableConceptThe type of contact
Binding The purpose for which you would contact a contact party (http://hl7.org/fhir/ValueSet/contactentity-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....name0..1HumanNameA name associated with the contact

.....id0..1Idxml:id (or equivalent in JSON)

.....use0..1Codeusual | official | temp | nickname | anonymous | old | maiden
Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use)
Binding Strength Required

.....text0..1StringText representation of the full name

.....family0..1StringFamily name (often called 'Surname')

.....given0..*StringGiven names (not always 'first'). Includes middle names

.....prefix0..*StringParts that come before the name

.....suffix0..*StringParts that come after the name

.....period0..1PeriodTime period when name was/is in use

......id0..1Idxml:id (or equivalent in JSON)

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....telecom0..*ContactPointContact details (telephone, email, etc.) for a contact

.....id0..1Idxml:id (or equivalent in JSON)

.....system0..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required

.....value0..1StringThe actual contact point details

.....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required

.....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

.....period0..1PeriodTime period when the contact point was/is in use

......id0..1Idxml:id (or equivalent in JSON)

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....address0..1AddressVisiting or postal addresses for the contact

.....id0..1Idxml:id (or equivalent in JSON)

.....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value work

.....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

.....text0..1StringText representation of the address
Example Value 1, Main Street, Leeds, West Yorkshire, LS1 3PO

.....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 1, Main Street

.....city0..1StringName of city, town etc.
Example Value Leeds

.....district0..1StringDistrict name (aka county)
Example Value West Yorkshire

.....postalCode0..1StringPostal code for area
Example Value LS1 3PO

.....country0..1StringCountry (can be ISO 3166 3 letter code)
Example Value GBR

.....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

......id0..1Idxml:id (or equivalent in JSON)

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

Name Type Description & Constraints
. . Extension-CareConnect-MainLocation-1 Extension This extension is constrained to represent a reference to the main location for an organization.
. . organization-period Extension The date range that this organization should be considered available.
Path Name Binding Strength ValueSet
.Organization.language language Required http://tools.ietf.org/html/bcp47
.Organization.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.Organization.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.Organization.type type Example http://hl7.org/fhir/ValueSet/organization-type
.Organization.telecom.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.Organization.telecom.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.Organization.address.use use Required http://hl7.org/fhir/ValueSet/address-use
.Organization.address.type type Required http://hl7.org/fhir/ValueSet/address-type
.Organization.contact.purpose purpose Extensible http://hl7.org/fhir/ValueSet/contactentity-type
.Organization.contact.name.use use Required http://hl7.org/fhir/ValueSet/name-use