The FHIR profiles used for Practitioner Role
Heading Description
A generic related person profile created using the CareConnect Level 2 CareConnect-RelatedPerson-1 profile, using the elements required to support its use within the Digital Maternity Messaging Specfication.
| > | Level 1 | RelatedPerson Resource | > | Level 2 | CareConnect-RelatedPerson | > | Level 3 | None |
| View Used FHIR Elements | [View All FHIR Elements] |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| RelatedPerson | | An person that is related to a patient, but who is not a direct target of care 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 |
||
| - 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-RelatedPerson-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 |
| - 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..* | Not Used | Identifier | A human identifier for this person |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - type | 0..1 | Not Used | 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 |
| - - - 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 |
| - - system | 0..1 | Not Used | Uri | The namespace for the identifier value |
| - - value | 0..1 | Not Used | 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 |
| - - - 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 |
| - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - - 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 |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - active | 0..1 | Not Used | Boolean | Whether this related person’s record is in active use Default Value: true |
| - patient | 1..1 | Mandatory | Reference | The patient this person is related to Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Patient-1 | |||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL This must use the CareConnect Patient profile.See patient resource reference for information on how to populate the resource. |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - relationship | 0..1 | Optional | CodeableConcept | The nature of the relationship Binding (preferred): The nature of the relationship between a patient and the related person PatientRelationshipType |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This SHOULD contain the value 'http://hl7.org/fhir/stu3/valueset-relatedperson-relationshiptype' if the preferred codeSystem is used. |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system This SHOULD contain a value from the preferred codeSystem |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the display associated with the code. |
| - - - 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..* | Required | HumanName | A name associated with the person Maximum 150 Characters a structured name may be sent if available. |
| - - 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 | Required | String | Text representation of the full name Mapping to Maternity Data item = 'Person accompanying patient' |
| - - family | 0..1 | Optional | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Optional | String | Given names (not always ‘first’). Includes middle names |
| - - prefix | 0..* | Optional | String | Parts that come before the name |
| - - suffix | 0..* | Optional | 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 | A contact detail for the person 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 |
| - gender | 0..1 | Not Used | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes. AdministrativeGender |
| - birthDate | 0..1 | Not Used | Date | The date on which the related person was born |
| - address | 0..* | Not Used | Address | Address where the related person can be contacted or visited |
| - - 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 |
| - photo | 0..* | Not Used | Attachment | Image of the person Constraint (att-1): It the Attachment has data, it SHALL have a contentType |
| - - contentType | 0..1 | Not Used | Code | Mime type of the content, with charset etc. Binding (required): The mime type of an attachment. Any valid mime type is allowed. Mime Type |
| - - language | 0..1 | Not Used | Code | Human language of the content (BCP-47) Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - - data | 0..1 | Not Used | base64Binary | Data inline, base64ed |
| - - url | 0..1 | Not Used | Uri | Uri where the data can be found |
| - - size | 0..1 | Not Used | unsignedInt | Number of bytes of content (if url provided) |
| - - hash | 0..1 | Not Used | base64Binary | Hash of the data (sha-1, base64ed) |
| - - title | 0..1 | Not Used | String | Label to display in place of the data |
| - - creation | 0..1 | Not Used | dateTime | Date attachment was first created |
| - period | 0..1 | Not Used | Period | Period of time that this relationship is considered valid 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 |