BBMRI.de/GBA Implementation Guide
1.2.0 - CI Build
BBMRI.de/GBA Implementation Guide - Local Development build (v1.2.0). See the Directory of published versions
Official URL: https://fhir.bbmri.de/StructureDefinition/Biobank | Version: 1.2.0 | |||
Active as of 2023-09-01 | Computable Name: Biobank |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription |
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson |
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) |
Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
identifier:Bbmri-EricId | S | 1..1 | Identifier | Identifies this organization across multiple systems |
system | S | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ |
value | SC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). |
name | S | 1..1 | string | Name used for the organization |
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for telecom | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | |
telecom:url | S | 0..* | ContactPoint | A contact detail for the organization |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | The actual contact point details | |
address | 1..* | Address | An address for the organization | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
country | S | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |
purpose | S | 1..1 | CodeableConcept | The type of contact |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: ADMIN | |
name | 1..1 | HumanName | A name associated with the contact | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 1..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |
purpose | S | 1..1 | CodeableConcept | The type of contact |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH | |
name | ||||
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
Slices for telecom | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 0..1 | string | The actual contact point details |
telecom:email | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
address | 1..1 | Address | Visiting or postal addresses for the contact | |
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
postalCode | S | 0..1 | string | Postal code for area |
country | S | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription |
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson |
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:Bbmri-EricId | SΣC | 1..1 | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ |
value | SΣC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:url | SC | 0..* | ContactPoint | A contact detail for the organization |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | C | 1..* | Address | An address for the organization |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
country | SΣ | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |
contact:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. |
name | 1..1 | HumanName | A name associated with the contact | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 1..1 | string | Family name (often called 'Surname') |
given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH |
name | 0..1 | HumanName | A name associated with the contact | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
Slices for telecom | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | 1..1 | Address | Visiting or postal addresses for the contact | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..* | string | Street 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 |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Organization.identifier:Bbmri-EricId.use | required | IdentifierUse |
Organization.telecom:url.system | required | Fixed Value: url |
Organization.telecom:url.use | required | ContactPointUse |
Organization.address.use | required | AddressUse |
Organization.contact:head.purpose | extensible | ContactEntityType |
Organization.contact:head.name.use | required | NameUse |
Organization.contact:contact.purpose | extensible | ContactEntityType |
Organization.contact:contact.name.use | required | NameUse |
Organization.contact:contact.telecom:phone.system | required | Fixed Value: phone |
Organization.contact:contact.telecom:phone.use | required | ContactPointUse |
Organization.contact:contact.telecom:email.system | required | Fixed Value: email |
Organization.contact:contact.telecom:email.use | required | ContactPointUse |
Organization.contact:contact.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription | ||||
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |||||
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson | ||||
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |||||
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |||||
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |||||
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |||||
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
identifier:Bbmri-EricId | SΣC | 1..1 | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ | ||||
value | SΣC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
telecom:url | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | C | 1..* | Address | An address for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | Σ | 0..* | string | Street 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 | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..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 | ||||
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |||||
contact:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: ADMIN | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 1..1 | HumanName | A name associated with the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | ||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 0..1 | HumanName | A name associated with the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |||||
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
id | 0..1 | string | 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): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
id | 0..1 | string | 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): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | 1..1 | Address | Visiting or postal addresses for the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | SΣ | 0..* | string | Street 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 | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..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"} | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Organization.language | preferred | CommonLanguages
| ||||
Organization.identifier:Bbmri-EricId.use | required | IdentifierUse | ||||
Organization.identifier:Bbmri-EricId.type | extensible | Identifier Type Codes | ||||
Organization.type | example | OrganizationType | ||||
Organization.telecom:url.system | required | Fixed Value: url | ||||
Organization.telecom:url.use | required | ContactPointUse | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact:head.purpose | extensible | ContactEntityType | ||||
Organization.contact:head.name.use | required | NameUse | ||||
Organization.contact:contact.purpose | extensible | ContactEntityType | ||||
Organization.contact:contact.name.use | required | NameUse | ||||
Organization.contact:contact.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.contact:contact.telecom:phone.use | required | ContactPointUse | ||||
Organization.contact:contact.telecom:email.system | required | Fixed Value: email | ||||
Organization.contact:contact.telecom:email.use | required | ContactPointUse | ||||
Organization.contact:contact.address.use | required | AddressUse | ||||
Organization.contact:contact.address.type | required | AddressType |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
This structure is derived from Organization
Summary
Mandatory: 19 elements (2 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 8 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription |
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson |
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) |
Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
identifier:Bbmri-EricId | S | 1..1 | Identifier | Identifies this organization across multiple systems |
system | S | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ |
value | SC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). |
name | S | 1..1 | string | Name used for the organization |
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for telecom | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | |
telecom:url | S | 0..* | ContactPoint | A contact detail for the organization |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | The actual contact point details | |
address | 1..* | Address | An address for the organization | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
country | S | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |
purpose | S | 1..1 | CodeableConcept | The type of contact |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: ADMIN | |
name | 1..1 | HumanName | A name associated with the contact | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 1..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |
purpose | S | 1..1 | CodeableConcept | The type of contact |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH | |
name | ||||
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
Slices for telecom | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 0..1 | string | The actual contact point details |
telecom:email | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
address | 1..1 | Address | Visiting or postal addresses for the contact | |
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
postalCode | S | 0..1 | string | Postal code for area |
country | S | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription |
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson |
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:Bbmri-EricId | SΣC | 1..1 | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ |
value | SΣC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:url | SC | 0..* | ContactPoint | A contact detail for the organization |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | C | 1..* | Address | An address for the organization |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
country | SΣ | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |
contact:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. |
name | 1..1 | HumanName | A name associated with the contact | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 1..1 | string | Family name (often called 'Surname') |
given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH |
name | 0..1 | HumanName | A name associated with the contact | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
Slices for telecom | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | 1..1 | Address | Visiting or postal addresses for the contact | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..* | string | Street 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 |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Organization.identifier:Bbmri-EricId.use | required | IdentifierUse |
Organization.telecom:url.system | required | Fixed Value: url |
Organization.telecom:url.use | required | ContactPointUse |
Organization.address.use | required | AddressUse |
Organization.contact:head.purpose | extensible | ContactEntityType |
Organization.contact:head.name.use | required | NameUse |
Organization.contact:contact.purpose | extensible | ContactEntityType |
Organization.contact:contact.name.use | required | NameUse |
Organization.contact:contact.telecom:phone.system | required | Fixed Value: phone |
Organization.contact:contact.telecom:phone.use | required | ContactPointUse |
Organization.contact:contact.telecom:email.system | required | Fixed Value: email |
Organization.contact:contact.telecom:email.use | required | ContactPointUse |
Organization.contact:contact.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
description | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription | ||||
bioresourceReference | 0..1 | string | Bioresource reference URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference | |||||
juridicalPerson | S | 1..1 | string | Extension URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson | ||||
itSupport | 0..1 | (Complex) | IT Support URL: https://fhir.bbmri.de/StructureDefinition/ITSupport | |||||
partnerCharterSigned | 0..1 | boolean | Partner charter signed URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned | |||||
collaboration | 0..1 | (Complex) | Collaboration URL: https://fhir.bbmri.de/StructureDefinition/Collaboration | |||||
capabilities | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/Capabilities Binding: Biobank Capabilities (required) | |||||
qualityStandard | S | 0..* | CodeableConcept | Extension URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard Binding: Quality Standard (required) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
identifier:Bbmri-EricId | SΣC | 1..1 | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://www.bbmri-eric.eu/ | ||||
value | SΣC | 0..1 | string | The value that is unique bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
telecom:url | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | C | 1..* | Address | An address for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
geolocation | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | Σ | 0..* | string | Street 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 | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..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 | ||||
Slices for contact | 2..* | BackboneElement | Contact for the organization for a certain purpose Slice: Unordered, Open by value:purpose.coding.code | |||||
contact:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
contact:head | S | 1..1 | BackboneElement | Contact for the organization for a certain purpose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
headRole | 0..1 | string | Head role URL: https://fhir.bbmri.de/StructureDefinition/ContactRole | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: ADMIN | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 1..1 | HumanName | A name associated with the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | ||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
contact:contact | 1..1 | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: RESEARCH | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 0..1 | HumanName | A name associated with the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |||||
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
id | 0..1 | string | 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): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
id | 0..1 | string | 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): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | 1..1 | Address | Visiting or postal addresses for the contact | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | SΣ | 0..* | string | Street 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 | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..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"} | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Organization.language | preferred | CommonLanguages
| ||||
Organization.identifier:Bbmri-EricId.use | required | IdentifierUse | ||||
Organization.identifier:Bbmri-EricId.type | extensible | Identifier Type Codes | ||||
Organization.type | example | OrganizationType | ||||
Organization.telecom:url.system | required | Fixed Value: url | ||||
Organization.telecom:url.use | required | ContactPointUse | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact:head.purpose | extensible | ContactEntityType | ||||
Organization.contact:head.name.use | required | NameUse | ||||
Organization.contact:contact.purpose | extensible | ContactEntityType | ||||
Organization.contact:contact.name.use | required | NameUse | ||||
Organization.contact:contact.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.contact:contact.telecom:phone.use | required | ContactPointUse | ||||
Organization.contact:contact.telecom:email.system | required | Fixed Value: email | ||||
Organization.contact:contact.telecom:email.use | required | ContactPointUse | ||||
Organization.contact:contact.address.use | required | AddressUse | ||||
Organization.contact:contact.address.type | required | AddressType |
Id | Grade | Path(s) | Details | Requirements |
bbmri-id-1 | warning | Organization.identifier:Bbmri-EricId.value | bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present). : matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$') | Make sure valid BBMRI IDs are provided |
This structure is derived from Organization
Summary
Mandatory: 19 elements (2 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 8 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron